Skip to content

docs(review): apply Tristan's two must-fix items from the final review#97

Merged
rodrigopavezi merged 1 commit into
mainfrom
docs/revamp-final-fixes
May 12, 2026
Merged

docs(review): apply Tristan's two must-fix items from the final review#97
rodrigopavezi merged 1 commit into
mainfrom
docs/revamp-final-fixes

Conversation

@rodrigopavezi
Copy link
Copy Markdown
Member

(1) api-reference/wallet-authentication.mdx — SIWE message example now
matches the actual server output from request-auth-api/auth.service.ts:

  • "Sign in to Request Network" → "Sign in to Request Network." (period
    per the source string)
  • Dropped the "Chain ID: 1" line (the server does not emit it)
  • Added "Expiration Time: " line (the server emits it after Issued
    At; used the same value the docs already show for expiresAt)

(2) api-setup/getting-started.mdx — Client ID Generation steps

  • Added a prerequisite step pointing users to create a payment
    destination first, because the Client IDs section is only visible
    once a destination exists.
  • Empty-state button labelled "Generate your first Client ID" (the
    actual dashboard label for the first-Client-ID case, per
    ManageDestination/blocks/ClientIdsSection.tsx). "Generate New Client
    ID" is still mentioned as the post-first-creation label.

@rodrigopavezi rodrigopavezi marked this pull request as ready for review May 12, 2026 01:56
This was referenced May 12, 2026
Copy link
Copy Markdown
Member Author

rodrigopavezi commented May 12, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 12, 2026

Greptile Summary

This PR applies two accuracy fixes identified in a final review: aligning the SIWE message example in the wallet-authentication docs with actual server output, and adding a payment-destination prerequisite to the Client ID generation steps.

  • api-reference/wallet-authentication.mdx: The example message string now ends with a period ("Sign in to Request Network."), removes the Chain ID: 1 line the server does not emit, and appends Expiration Time (using the same ISO timestamp already shown in expiresAt).
  • api-setup/getting-started.mdx: A new step 2 explicitly tells users to create a payment destination first, since the Client IDs section only appears after one exists. Subsequent steps are renumbered, and the button label distinguishes between the first-time empty-state ("Generate your first Client ID") and subsequent creation ("Generate New Client ID").

Confidence Score: 5/5

Safe to merge — both changes are documentation-only accuracy corrections with no functional code impact.

Both files contain only documentation text changes. The SIWE message update brings the example into sync with the real server output (period, no Chain ID, Expiration Time field), and the getting-started update adds a clearly missing prerequisite step that prevents user confusion at the dashboard. Neither change introduces incorrect information or breaks any existing guidance.

No files require special attention. The top-level Quick Setup Steps block in getting-started.mdx still omits the payment-destination prerequisite, but this was flagged in a prior review and does not block this PR.

Important Files Changed

Filename Overview
api-reference/wallet-authentication.mdx Updated SIWE message example to match actual server output: added trailing period to statement, removed Chain ID field, and added Expiration Time field aligned with the expiresAt value already shown in the response.
api-setup/getting-started.mdx Added payment-destination prerequisite step and corrected button label for first-time vs. returning Client ID creation; numbered steps renumbered to 1–5 accordingly.

Sequence Diagram

sequenceDiagram
    participant User
    participant Dashboard
    participant AuthAPI as auth.request.network
    participant Wallet

    User->>Dashboard: Sign up / Log in
    User->>Dashboard: Set up payment destination
    Dashboard-->>User: Destination created (Client IDs section now visible)
    User->>Dashboard: Open Manage Destination → Client IDs
    User->>Dashboard: Click "Generate your first Client ID"
    Dashboard-->>User: Client ID issued

    Note over User,AuthAPI: Wallet Auth (SIWE) Flow
    User->>AuthAPI: "POST /v1/auth/wallet/challenge {address}"
    AuthAPI-->>User: "{challengeId, nonce, message, expiresAt}"
    Note right of AuthAPI: message includes: Sign in to Request Network. No Chain ID field. Expiration Time = expiresAt
    User->>Wallet: Sign message
    Wallet-->>User: signature
    User->>AuthAPI: "POST /v1/auth/wallet/verify {challengeId, nonce, message, signature}"
    AuthAPI-->>User: httpOnly session cookie
Loading

Reviews (2): Last reviewed commit: "docs(review): apply Tristan's two must-f..." | Re-trigger Greptile

Copy link
Copy Markdown
Member

@MantisClone MantisClone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. SIWE fix matches the server template exactly (period present, no Chain ID line, Expiration Time set 5 min after Issued At = matches existing expiresAt two lines below). getting-started Client ID Generation flow now reflects the actual Dashboard UI: destination-creation prerequisite + both button labels with their conditions. Verified against request-auth-api/src/auth/auth.service.ts:187-196 and request-dashboard/src/pages/ManageDestination/blocks/ClientIdsSection.tsx:107-129. Ready to ship.

Copy link
Copy Markdown
Member Author

rodrigopavezi commented May 12, 2026

Merge activity

  • May 12, 4:02 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • May 12, 5:24 PM UTC: Graphite rebased this pull request as part of a merge.
  • May 12, 5:25 PM UTC: @rodrigopavezi merged this pull request with Graphite.

@rodrigopavezi rodrigopavezi changed the base branch from docs/revamp-greptile-fixes to graphite-base/97 May 12, 2026 17:22
@rodrigopavezi rodrigopavezi changed the base branch from graphite-base/97 to main May 12, 2026 17:23
(1) api-reference/wallet-authentication.mdx — SIWE message example now
matches the actual server output from request-auth-api/auth.service.ts:
- "Sign in to Request Network" → "Sign in to Request Network." (period
  per the source string)
- Dropped the "Chain ID: 1" line (the server does not emit it)
- Added "Expiration Time: <iso>" line (the server emits it after Issued
  At; used the same value the docs already show for `expiresAt`)

(2) api-setup/getting-started.mdx — Client ID Generation steps
- Added a prerequisite step pointing users to create a payment
  destination first, because the Client IDs section is only visible
  once a destination exists.
- Empty-state button labelled "Generate your first Client ID" (the
  actual dashboard label for the first-Client-ID case, per
  ManageDestination/blocks/ClientIdsSection.tsx). "Generate New Client
  ID" is still mentioned as the post-first-creation label.
@rodrigopavezi rodrigopavezi force-pushed the docs/revamp-final-fixes branch from e3188be to 955e887 Compare May 12, 2026 17:24
@rodrigopavezi rodrigopavezi merged commit 9b7ff89 into main May 12, 2026
3 checks passed
@rodrigopavezi rodrigopavezi deleted the docs/revamp-final-fixes branch May 12, 2026 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants